gulp详细入门教程 (打造一个自动化的前端项目)

工具介绍

nodeJS

nodeJS的出现，可以算是前端里程碑式的一个事件，它让前端攻城狮们摆脱了浏览器的束缚，踏上了一个更加宽广的舞台。前端的可能性，从此更加具有想象空间。
随着一系列基于nodes的应用/工具的出现，工作中与nodeJS打交道的机会越来越多。无论在node应用的开发，还是使用中，包管理都扮演着一个很重要的作用。NPM（node package manager），作为node的包管理工具，极大地便利了我们的开发工作，很有必要了解一下。

NPM
NPM（node package manager），通常称为node包管理器。顾名思义，它的主要功能就是管理node包，包括：安装、卸载、更新、查看、搜索、发布等。

NPM的背后，是基于couchdb的一个数据库，详细记录了每个包的信息，包括作者、版本、依赖、授权信息等。它的一个很重要的作用就是：将开发者从繁琐的包管理工作（版本、依赖等）中解放出来，更加专注于功能的开发。

gulp

gulp是基于Nodejs的自动任务运行器，她能自动化地完成 javascript/coffee/sass/less/html/image/css 等文件的的测试、检查、合并、压缩、格式化、浏览器自动刷新、部署文件生成，并监听文件在改动后重复指定的这些步骤。在实现上，她借鉴了Unix操作系统的管道（pipe）思想，前一级的输出，直接变成后一级的输入，使得在操作上非常简单。通过本文，我们将学习如何使用Gulp来改变开发流程，从而使开发更加快速高效。

gulp 和 grunt 非常类似，但相比于 grunt 的频繁 IO 操作，gulp 的流操作，能更快地更便捷地完成构建工作。

gulp常用地址：

gulp官方网址：http://gulpjs.com
gulp插件地址：http://gulpjs.com/plugins
gulp 官方API：https://github.com/gulpjs/gulp/blob/master/docs/API.md
gulp 中文API：http://www.ydcss.com/archives/424

使用gulp的步骤

首先当然是安装nodejs，通过nodejs的npm全局安装和项目安装gulp
在项目里安装所需要的gulp插件，然后新建gulp的配置文件gulpfile.js并写好配置信息（定义gulp任务）
最后通过命令提示符运行gulp任务即可。
安装nodejs -> 全局安装gulp -> 项目安装gulp以及gulp插件 -> 配置gulpfile.js -> 运行任务

nodejs安装：

gulp是基于nodejs，理所当然需要安装nodejs。
nodejs官网
使用命令行
命令行在OSX是终端（Terminal），在windows是命令提示符（Command Prompt）

gulp在使用过程中常用命令
打开命令提示符执行下列命令（打开方式：window + r 输入cmd回车）：
node -v 查看安装的nodejs版本，出现版本号，说明刚刚已正确安装nodejs。
npm -v 查看npm的版本号，npm是在安装nodejs时一同安装的nodejs包管理器.
cd 定位到目录，用法：cd + 路径；
dir 列出文件列表；
cls 清空命令提示符窗口内容。

npm介绍

npm（node package manager）nodejs的包管理器，用于node插件管理（包括安装、卸载、管理依赖等）；

使用npm安装插件：命令提示符执行npm install <name> [-g] [--save-dev]；
：node插件名称。例：npm install gulp-less --save-dev
-g：全局安装。将会安装在C:\Documents and Settings\Administrator\Application Data\npm，并且写入系统环境变量；
非全局安装：不带’-g’,将会安装在当前定位目录；
全局安装可以通过命令行在任何地方调用它，本地安装将安装在定位目录的node_modules文件夹下，通过require()调用；
–save：将保存配置信息至package.json（package.json是nodejs项目配置文件）；
-dev：保存至package.json的devDependencies节点，不指定-dev将保存至dependencies节点；一般保存在dependencies的像这些express/ejs/body-parser等等。

为什么要保存至package.json？因为node插件包相对来说非常庞大，所以不加入版本管理，将配置信息写入package.json并将其加入版本管理，其他开发者对应下载即可（命令提示符执行npm install，则会根据package.json下载所有需要的包，npm install –production只下载dependencies节点的包）。

注意
安装sass插件时，会报错，出现无法安装的情况。
npm install sass -g
因为sass是基于ruby环境的，需要先安装ruby，然后在ruby下的命令行’Start command prompt with Ruby’下输入：’gem install sass’.

使用npm卸载插件：npm uninstall <name> [-g] [--save-dev]PS：不要直接删除本地插件包
删除全部插件：npm uninstall gulp-less gulp-uglify gulp-concat ……
借助rimraf：npm install rimraf -g 用法：rimraf node_modules
使用npm更新插件：npm update <name> [-g] [--save-dev]
更新全部插件：npm update [--save-dev]
查看npm帮助：npm help
查看当前目录已安装插件：npm list

选装cnpm

因为npm安装插件是从国外服务器(http://registry.npmjs.org)下载，受网络影响大，可能出现异常，因此可选择国内镜像安装插件。

cnpm:这是一个完整 npmjs.org 镜像，你可以用此代替官方版本(只读)，同步频率目前为 10分钟一次以保证尽量与官方服务同步。
官方网址：http://npm.taobao.org；
安装：命令提示符执行npm install cnpm -g --registry=https://registry.npm.taobao.org
注意：安装完后最好查看其版本号cnpm -v或关闭命令提示符重新打开，安装完直接使用有可能会出现错误；
注：cnpm跟npm用法完全一致，只是在执行命令时将npm改为cnpm（以下操作将以cnpm代替npm）。

全局安装gulp安装

命令：cnpm install -g gulp
查看是否正确安装：命令提示符执行gulp -v，出现版本号即为正确安装。

新建package.json文件

package.json是基于nodejs项目必不可少的配置文件，它是存放在项目根目录的普通json文件；它是这样一个json文件（注意：json文件内是不能写注释的，下面的注释需要删除掉）：

{
  "name": "test",   //项目名称（必须）
  "version": "1.0.0",   //项目版本（必须）
  "description": "This is for study gulp project !",   //项目描述（必须）
  "homepage": "",   //项目主页
  "repository": {    //项目资源库
    "type": "git",
    "url": "https://git.oschina.net/xxxx"
  },
  "author": {    //项目作者信息
    "name": "xifengxx",
    "email": "xifengxx2163.com"
  },
  "license": "ISC",    //项目许可协议
  "devDependencies": {    //项目依赖的插件
    "gulp": "^3.8.11",
    "gulp-less": "^3.0.0"
  }
}

我们可以手动新建这个配置文件，也可以在命令行终端中新建：
命令提示符执行cnpm init,然后根据提示填写相关信息即可。
查看package.json帮助文档，命令提示符执行cnpm help package.json

本地安装gulp及gulp插件

将gulp安装在全局环境后，在具体项目处理时，输入命令”gulp”，会出现错误：

$ gulp
[10:26:46] Local gulp not found in ~\桌面\auto-web
[10:26:46] Try running: npm install gulp
因此，具体项目操作时，应将gulp再安装到项目本地文件夹下.
项目本地安装
命令：$ cnpm install gulp --save-dev
全局安装了gulp，项目也安装了gulp，全局安装gulp是为了执行gulp任务，本地安装gulp则是为了调用gulp插件的功能。

gulp插件安装：

$ npm install gulp-name1 gulp-name2 –save-dev

注意：通过cnpm安装gulp及gulp插件时，可能会出现无法安装的情形，诸如如下错误提示信息：

$ cnpm install gulp --save-dev

Error: EISDIR: illegal operation on a directory, symlink 'D:...\node_modules\.npminstall\archy\1.0.0\archy' -> 'D:...\node_modules\.npminstall\gulp\3.9.1\gulp\node_modules\archy'
at error (native)

我在安装gulp或gulp插件时，就曾遇到这种情况，将gulp及gulp插件删除cnpm uninstall gulp --save-dev,再重新安装，还是会出现这个错误，网上的方法都无法解决问题。
后来发现是cnpm的问题，即淘宝镜像中npm下的某些插件会与gulp中的相应插件不兼容。

解决方法：改用npm安装gulp及gulp插件即可。

新建gulpfile.js文件

gulpfile.js是gulp项目的配置文件，是位于项目根目录的普通js文件（其实将gulpfile.js放入其他文件夹下亦可）。
它大概是这样一个js文件：

//导入工具包 require('node_modules里对应模块')
var gulp = require('gulp'), //本地安装gulp所用到的地方
    sass = require('gulp-sass');
 
//定义一个styles任务（自定义任务名称）
gulp.task('styles',function(){
    gulp.src('./src/sass/*.scss')//该任务针对的文件
        .pipe(sass())//该任务调用的模块
        .pipe(gulp.dest('./dist/css'))//将会在dist/css下生成*.css文件
})
 
gulp.task('default',['styles', 'elseTask']); //定义默认任务 elseTask为其他任务，该示例没有定义elseTask任务
 
//gulp.task(name[, deps], fn) 定义任务  name：任务名称 deps：依赖任务名称 fn：回调函数
//gulp.src(globs[, options]) 执行任务处理的文件  globs：处理的文件路径(字符串或者字符串数组) 
//gulp.dest(path[, options]) 处理完后文件生成路径

gulp使用方法

创建目标: gulp.task('',[],function(){})
//例子1（默认）：

1
2
3

gulp.task('default',function() {
    console.log('我是default')
});

//运行结果：

$ gulp  //终端运行命令，后面不跟东西，默认执行default
[21:54:33] Using gulpfile ~/Desktop/nodeJS/gulp/gulpfile.js
[21:54:33] Starting 'default'...
我是default
[21:54:33] Finished 'default' after 120 μs

//例子2（自定义）

1
2
3

gulp.task('task1',function () {
    console.log('我是task1')
})

//运行结果：

$ gulp task1  //后面跟上自定义的任务名称
[21:58:00] Using gulpfile ~/Desktop/nodeJS/gulp/gulpfile.js
[21:58:00] Starting 'task1'...
我是task1
[21:58:00] Finished 'task1' after 121 μs

//例子3（复合）

1
2
3

gulp.task('default',['task1'],function() {
     console.log('我是default')
});

//运行结果：

$ gulp  //先执行自定义，后执行默认
[22:01:33] Using gulpfile ~/Desktop/nodeJS/gulp/gulpfile.js
[22:01:33] Starting 'task1'...
我是task1
[22:01:33] Finished 'task1' after 99 μs
[22:01:33] Starting 'default'...
我是default
[22:01:33] Finished 'default' after 38 μs

目标文件: gulp.src('')
目标输出: gulp.dest('')
管道（上文的输出是下文的输入）: .pipe()
//举例

gulp.task('min',function () {
  gulp.src('js/*.js')          //外部引用
  .pipe(concat('new.js'))        //合并多个js文件，并生成一个新的文件
  .pipe(jsmin())                //压缩这个新生成的js文件
  .pipe(gulp.dest('newJS/'))    //将新生成的文件放入新的文件夹中
})

清除文件

在任务执行前，最好先清除之前生成的文件：

1
2
3

gulp.task('clean', function(cb) {
    del(['dist/assets/css', 'dist/assets/js', 'dist/assets/img'], cb)
});

在这里没有必要使用Gulp插件了，可以使用NPM提供的插件。我们用一个回调函数（cb）确保在退出前完成任务。

设置默认任务（default）

我们在命令行下输入$ gulp执行的就是默认任务，现在我们为默认任务指定执行上面写好的三个任务：

1
2
3

gulp.task('default', ['clean'], function() {
    gulp.start('styles', 'scripts', 'images');
});

在这个例子里面，clean任务执行完成了才会去运行其他的任务，在gulp.start()里的任务执行的顺序是不确定的，所以将要在它们之前执行的任务写在数组里面。

监听文件

在实际的开发过程中，不管我们修改什么文件，只需要 gulp 一下即可，方便了很多。但是仍然每次修改都得执行一下。可不可以让 gulp 来监听我们的文件变化，然后自动重新执行编译任务呢？
答案是可以的。只需要将这些任务加入监控 watch 就行了：

gulp.task('watch',function(){
  gulp.watch('./src/sass/*.scss',['styles']);
  gulp.watch('./src/coffee/*.coffee',['scripts']);
  gulp.watch('./views/*.jade',['templates']);
})

我们将不同类型的文件分开处理，执行对应的数组里的任务。现在我们可以在命令行输入$ gulp watch执行监听任务，当.sass、.js和图片修改时将执行对应的任务。
不管我们做了什么修改，都不用再次执行 gulp 了。
怎么退出gulp wach模式：Ctrl + C

自动刷新页面

Gulp也可以实现当文件修改时自动刷新页面，我们要修改watch任务，配置LiveReload：

gulp.task('watch', function() {
  // Create LiveReload server
  livereload.listen();
  // Watch any files in dist/, reload on change
  gulp.watch(['dist/**']).on('change', livereload.changed);
});